salvo-oapi 0.43.0

salvo_oapi allows you to easily implement Apis that comply with the OpenApiv3 specification. It uses procedural macros to generate a lots of boilerplate code, so that you only need to focus on the more important business implementations.

• Docs
• Cargo package

Features

• Type safety If your codes can be compiled, then it is fully compliant with the OpenApi v3 specification.
• Rustfmt friendly Do not create any DSL that does not conform to Rust's syntax specifications.
• IDE friendly Any code generated by the procedural macro will not be used directly.
• Minimal overhead All generated code is necessary, and there is almost no overhead.

Crate features

To avoid compiling unused dependencies, salvo_oapi gates certain features, some of which are disabled by default:

Safety

This crate uses #![forbid(unsafe_code)] to ensure everything is implemented in 100% Safe Rust.

Example

use salvo_core::prelude::*;
use salvo_oapi::extract::QueryParam;

#[endpoint]
async fn hello(body: QueryParamOption<String>>, res: &mut Response) {
    res.render(format!("{:?}", body))
}

#[tokio::main]
async fn main() -> Result<(), std::io::Error> {
    let router = Router::new()
        .push(Router::with_path("hello").get(hello))

    let doc = OpenApi::new("Hello API", "0.0.1").merge_router(&router);

    let router = router
        .push(doc.into_router("/api-doc/openapi.json"))
        .push(SwaggerUi::new("/api-doc/openapi.json").into_router("swagger-ui"));

    let acceptor = TcpListener::new("127.0.0.1:5800").bind().await;
    Server::new(acceptor).serve(router).await;
}

This feature needs to be opted-in. It can be done by adding the feature in Cargo.toml file

[dependencies]
salvo = { version = "0.39", features = ["oapi"]}
tokio = { version = "1", features = ["full"] }

Run example

Open http://localhost:5800/ in your browser, you will see the Swagger UI that contains these Api definitions.

> cargo run --example hello_world

> curl http://localhost:5800
hello!

> curl http://localhost:5800\?name\=chris
hello, chris!        

Contributing

:balloon: Thanks for your help improving the project! We are so happy to have you!

License

Licensed under either of

• Apache License, Version 2.0,(LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in salvo_oapi by you, shall be licensed as Apache, without any additional terms or conditions.